LotusScript Doc

Class: LSAAddressManager

Manage all operations on Lotus Domino objects for the address interface.

Version:
1.2.5, 11.AUG.2000
History:
11.AUG.2000RGRbug in CountriesWithoutAreaCode
01.AUG.2000RGRphoneFormat temporary changed
25.JUL.2000RGRproperties PhoneFormat and CountriesWithoutAreaCode added
25.JUL.2000RGRWrong constants used for views
08.JUN.2000RGRDelete method changed



Property Summary
Public Property Get AddressDB As NotesDatabase
Public Property Get AddressLUView As NotesView
Public Property Get AttributeArray As Variant
Public Property Get ClosingFormats As Variant
Public Property Get ClosingTypes As Variant
Public Property Get ContactDisplayRule As String
Public Property Get ContactLUView As NotesView
Public Property Get CountriesWithoutAreaCode As Variant
Public Property Get CustomerLUView As NotesView
Public Property Get GlossaryAlias As String
Public Property Get GlossaryDB As NotesDatabase
Public Property Get HierarchyView As NotesView
Public Property Get IdLUView As NotesView
Public Property Get IndexView As NotesView
Public Property Get InstanceID As String
Public Property Get LabelFormats As Variant
Public Property Get LabelTypes As Variant
Public Property Get LogView As NotesView
Public Property Get OpeningFormats As Variant
Public Property Get OpeningTypes As Variant
Public Property Get OrganizationDisplayRule As String
Public Property Get OrganizationLUView As NotesView
Public Property Get PhoneFormat As String
Public Property Set PhoneFormat As String

Method Summary
Sub Delete ()
Function getAddressDocsByKey (key As String) As NotesDocumentCollection
Function getContactUnitByName (contactName As String) As LSAAddrUnit
Function GetDatabaseByAliasParameter (aliasName As String, DefaultAlias As String) As NotesDatabase
Function getDatabaseByDBParameter (DBase As Variant) As NotesDatabase
Function getOrganizationUnitByName (orgName As String) As LSAAddrUnit
Function getUnitByCustomerKey (key As String) As LSAAddrUnit
Function getUnitByID (id As String) As LSAAddrUnit
Function getUnitBySyncKey (externalSystem As String, key As String) As LSAADDRUnit
Sub IsAddrDB ()
Sub New (Database As Variant, AddrDBAlias As String)
Function NewUnit (doc As NotesDocument, unitType As String) As LSAAddrUnit

Property Detail

Public Property Get AddressDB AsNotesDatabase

Returns the database on which the LSAAddrManager object works

Summmary Top

Public Property Get InstanceID AsString

Lazy initialization of the instance ID which is generated by the instance manager class.

Summmary Top

Public Property Get AddressLUView AsNotesView

Lazy initialization for the view which is used to lookup addresses.

Summmary Top

Public Property Get ContactLUView AsNotesView

Lazy initialization for the view which is used to lookup units of type contact

Summmary Top

Public Property Get OrganizationLUView AsNotesView

Lazy initialization for the view which is used to lookup units of type organization

Summmary Top

Public Property Get IdLUView AsNotesView

Lazy initialization for the view which is used to lookup units of type contact

History:
25.JUL.2000RGRWrong constant used for view.
Summmary Top

Public Property Get CustomerLUView AsNotesView

Lazy initialization for the view which is used to lookup unit in a customer view

History:
25.JUL.2000RGRWrong constant used for view.
Summmary Top

Public Property Get AttributeArray AsVariant

Lazy initialization for the attribute mapping. If an error occurs in the first initialisation empty is returned

Summmary Top

Public Property Get LabelTypes AsVariant

Lazy initialization for the label types. If an error occurs in the first initialisation empty is returned

Summmary Top

Public Property Get LabelFormats AsVariant

Lazy initialization for the label formats If an error occurs in the first initialisation empty is returned

Summmary Top

Public Property Get OpeningTypes AsVariant

Lazy initialization for the opening types If an error occurs in the first initialisation empty is returned

Summmary Top

Public Property Get OpeningFormats AsVariant

Lazy initialization for the opening formats If an error occurs in the first initialisation empty is returned

Summmary Top

Public Property Get ClosingTypes AsVariant

Lazy initialization for the closing types If an error occurs in the first initialisation empty is returned

Summmary Top

Public Property Get ClosingFormats AsVariant

Lazy initialization for the closing formats If an error occurs in the first initialisation empty is returned

Summmary Top

Public Property Get ContactDisplayRule AsString

Lazy initialization for the Contact display rule

Summmary Top

Public Property Get OrganizationDisplayRule AsString

Lazy initialization for the organization display rule

Summmary Top

Public Property Get PhoneFormat AsString

Lazy initialization for the phone format

Summmary Top

Public Property Set PhoneFormat AsString

Summmary Top

Public Property Get CountriesWithoutAreaCode AsVariant

Lazy initialization for the the list of country codes which doesn't require/need an area code.
If an error occurs, the value is set to an empty array.

History:
11.AUG.2000RGRempty array as return value
Summmary Top

Public Property Get GlossaryAlias AsString

Lazy initialization for the Glossary alias name which is in Configure

Summmary Top

Public Property Get GlossaryDB AsNotesDatabase

Returns the database for Glossary opertaions

Summmary Top

Public Property Get HierarchyView AsNotesView

Lazy initialization for the view which is used to represent the keywords sorted by their serialized/internal representation

Summmary Top

Public Property Get IndexView AsNotesView

Lazy initialization for the view which is used to represent the keywords sorted by their visual/external representatoion

Summmary Top

Public Property Get LogView AsNotesView

Lazy initialization for the view which is used to track changes in the Glossary database

Summmary Top
Method Detail

New

Public Sub New(Database As Variant,AddrDBAlias As String)
Instantiates a new object for a database. The database parameter can either be a NotesDatabase, an alias name or a path to a specific database (in the form server!!path).

Summmary Top

Delete

Public Sub Delete
Destructs the object and check it out of the instance manager

History:
08.JUN.2000RGRcheck out of the instance implemented
Summmary Top

NewUnit

Public Function NewUnit(doc As NotesDocument,unitType As String) As LSAAddrUnit
Creates a new LSAAddrUnit object. If the first parameter is nothing a new document is created.

Summmary Top

getContactUnitByName

Public Function getContactUnitByName(contactName As String) As LSAAddrUnit
Looks if a LSAAddrUnit of type Contact with Name contact Name is available in the database which is used by the LSAAddrManager. The contactName must be of the form:

Parameters:
contactNameStringname of the searched contact person
Returns:
LSAAddrUnitthe object corresponding to the contactName or Nothing
Summmary Top

getOrganizationUnitByName

Public Function getOrganizationUnitByName(orgName As String) As LSAAddrUnit
Looks if a LSAAddrUnit of type Organization with Name orgName is available in the database which is used by the LSAAddrManager. The orgName should be of the form: The hierarchy levels should be seperated by the backslash charcter, e.g. ACME\Development\Documentation is the subdepartment "Documentation" of the department "Development" of "ACME" corporation. If the AddressManager looks up an organization by name he replaces the backslash characters ("\") by pipe characters ("|") and make it a serial string by setting to pipe characters as first characters of the key. For the example above this means: ||ACME|Development|Documentation This key is in sync with the View LSAAddrLuOrganizationByName as described in the LSA-DocuPack.

Parameters:
orgNameStringhierarchical name of the searched organization
Returns:
LSAAddrUnitthe object corresponding to the orgName or Nothing
Summmary Top

getUnitByID

Public Function getUnitByID(id As String) As LSAAddrUnit
Looks if a LSAAddrUnit with is the requested ID is available in the database which is used by the LSAAddrManager.

Parameters:
idStringid of the searched unit
Returns:
LSAAddrUnitthe object corresponding to the id or Nothing
Summmary Top

getUnitByCustomerKey

Public Function getUnitByCustomerKey(key As String) As LSAAddrUnit
Looks if a LSAAddrUnit with the requested key is available in the database which is used by the LSAAddrManager.

Parameters:
keyStringkey of the searched unit
Returns:
LSAAddrUnitthe object corresponding to the id or Nothing
Summmary Top

getUnitBySyncKey

Public Function getUnitBySyncKey(externalSystem As String,key As String) As LSAADDRUnit
Given a external System name and synchronization key this function returns the corresponding unit. If no unit can be found NOTHING is returned.

History:
25.JUL.2000RGRUnit type is now computed by constructor of unit
Summmary Top

IsAddrDB

Private Sub IsAddrDB
Checks if the database is passed in as parameter provides the necessary views which are need by the LSA-Address interface classes

Parameters:
DBaseNotesDatabasedatabase which should be tested on compliance
Returns:
Booleantrue, if the necessary interfaces are provided by the database
Summmary Top

getDatabaseByDBParameter

Private Function getDatabaseByDBParameter(DBase As Variant) As NotesDatabase
Checks the type of the parameter and converts it into NotesDatabase. This function is called in the constructor. Possible types are: - array of strings : [server, path] - String : "!!" or "" - Notesdatabase If the parameter doesn't match one of the types Nothing is returned. If the parameter matches one of the types but the database object cannot be instantiated an error is thrown.

Parameters:
DBaseVariantone of three types to identify a Notes database object
Returns:
NotesDatabasethe reuqested database object or Nothing
Summmary Top

GetDatabaseByAliasParameter

Private Function GetDatabaseByAliasParameter(aliasName As String,DefaultAlias As String) As NotesDatabase
Tries to open the database which is specified by the aliasName by looking up its Path in LSAConfigure. If the aliasName is an empty string ("") the default alias name ("LSAAddr") is used.

Parameters:
aliasNameStringlogical name of the database as defined in LSA-Configure
Returns:
NotesDatabasethe database which corresponds to the aliasName
Errors:
ErrCannotOpenDatabasethrown, if database cannot be instantiated @err ErrDatabaseByAliasNotFound thrown,if aliasName cannot be found in Configure
Summmary Top

getAddressDocsByKey

Public Function getAddressDocsByKey(key As String) As NotesDocumentCollection
Returns all address documents which are belonging to a contact or an organization. The key is an internal key which is used by the unit

Summmary Top

TopLotusScript Doc
© Lotus Professional Services
generated on : 05-Apr-01 8:45:33 AM